vFire has two Application Programming Interfaces (or APIs), which enable you to develop programs that automate many common vFire transactions. This section of the documentation deals with the Classic API. For more information on the RESTful Alemba API, introduced in 9.7, see here.
The Classic API provides knowledge transactions to create, update, delete and retrieve knowledge articles. There is also a transaction to take feedback on articles.
Messaging transactions are also provided to send knowledge articles to Users, analysts and groups. See MessageSendMessage Transaction for more information.
KnowledgeCreate Transaction
The KnowledgeCreate transaction can be used to create a knowledge entry. The type of entry to be created can be passed as an input parameter.
Input Parameters: KnowledgeCreateRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Ignored |
- |
Ignored on Create |
|
lEntityType |
Lookup Field |
No |
500 (Abstract) |
Knowledge Entry Type |
|
sAbstract |
String |
No |
“” |
Knowledge Entry Abstract field. |
|
sTitle |
String |
Yes |
“” |
Knowledge Entry title |
|
sAdditionalInfo |
String |
No |
“” |
Knowledge Entry Additional Information field |
|
sFreeText |
String |
No |
“” |
HTML Knowledge Body |
|
sSolution |
String |
No |
“” |
Knowledge Entry Solution field |
|
nCreditedItemVersion |
Integer |
No |
0 |
Last major credited version of the knowledge bank entry |
|
lStatus |
Lookup Field |
No |
0 |
Knowledge Entry status |
|
sExternalRef |
String |
No |
“” |
Knowledge Entry External Ref field |
|
lCall |
Lookup Field |
No |
0 |
Call Number linked to this Knowledge Entry |
|
lProfileRef |
Lookup Field |
No |
0 |
Knowledge Profile |
|
bIndexSubDirs |
Boolean |
No |
False |
Flag whether to index subdirectories. Values:
|
|
nFrequency |
Integer |
No |
0 |
Frequency |
|
nTraversalDepth |
Integer |
No |
0 |
Traversal Depth |
|
lFormat |
Lookup Field |
No |
Plain Text |
Knowledge Format. Values: 1 = Plain Text 2 = HTML 3 = Related HTML |
|
lService |
Lookup Field |
No |
0 |
Service linked to this Knowledge Entry |
|
yLite |
Yes/No |
No |
N |
Flag whether this Knowledge Entry will be available on the Self Service Portal. Values:
|
|
yReviewRequired |
Yes/No |
No |
N |
Flag whether this Knowledge Entry needs to be reviewed. Values:
|
|
nCompositeTypeRef |
Integer |
No |
0 |
Knowledge Type. The reference number provided can correspond to lower Knowledge Type tiers. |
|
dExpires |
Date/Time |
No |
(null) |
Knowledge entry expiry date |
|
dNextReview |
Date/Time |
No |
(null) |
Knowledge entry next review date |
|
sComments |
String |
No |
“” |
Comments |
|
lPartition |
Lookup Field |
No |
Analyst’s default partition |
Partition in which to create the Knowledge Entry |
|
lSecurityProfile |
Lookup Field |
No |
0 |
Security profile to apply to the Knowledge Entry |
|
aCustomParameters |
Array |
No |
“” |
Return Values: KnowledgeResponse
|
Argument |
Type |
Description |
|---|---|---|
|
nEntityRef |
Integer |
New Knowledge Ref |
|
String |
Error/Warning Message |
|
|
Ret |
Error/Warning Number |
KnowledgeUpdate Transaction
The KnowledgeUpdate transaction can be used to modify an existing knowledge entry.
Input Parameters: KnowledgeUpdateRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Reference number of the Knowledge entry to update |
|
lEntityType |
Lookup Field |
No |
(As is) |
Knowledge Entry Type and Major Type |
|
sAbstract |
String |
No |
(As is) |
Knowledge Entry Abstract field. |
|
sTitle |
String |
No |
(As is) |
Knowledge Entry title |
|
sAdditionalInfo |
String |
No |
(As is) |
Knowledge Entry Additional Information field |
|
sFreeText |
String |
No |
(As is) |
HTML Knowledge Body |
|
sSolution |
String |
No |
(As is) |
Knowledge Entry Solution field |
|
nCreditedItemVersion |
Integer |
No |
(As is) |
Last major credited version of the knowledge bank entry |
|
lStatus |
Lookup Field |
No |
(As is) |
Knowledge Entry status |
|
sExternalRef |
String |
No |
(As is) |
Knowledge Entry External Ref field |
|
lCall |
Lookup Field |
No |
(As is) |
Call Number linked to this Knowledge Entry |
|
lProfileRef |
Lookup Field |
No |
(As is) |
Knowledge Profile |
|
bIndexSubDirs |
Boolean |
No |
(As is) |
Flag whether to index subdirectories. Values:
|
|
nFrequency |
Integer |
No |
(As is) |
Frequency |
|
nTraversalDepth |
Integer |
No |
(As is) |
Traversal Depth |
|
lFormat |
Lookup Field |
No |
(As is) |
Knowledge Format. Values: 1 = Plain Text 2 = HTML 3 = Related HTML |
|
lService |
Lookup Field |
No |
(As is) |
Service linked to this Knowledge Entry |
|
yLite |
Yes/No |
No |
(As is) |
Flag whether this Knowledge Entry will be available on the Self Service Portal. Values:
|
|
yReviewRequired |
Yes/No |
No |
(As is) |
Flag whether this Knowledge Entry needs to be reviewed. Values:
|
|
nCompositeTypeRef |
Integer |
No |
(As is) |
Knowledge Type. The reference number provided can correspond to lower Knowledge Type tiers. |
|
dExpires |
Date/Time |
No |
(As is) |
Knowledge entry expiry date |
|
dNextReview |
Date/Time |
No |
(As is) |
Knowledge entry next review date |
|
sComments |
String |
No |
(As is) |
Comments |
|
lPartition |
Lookup Field |
No |
(As is) |
Partition in which to create the Knowledge Entry |
|
lSecurityProfile |
Lookup Field |
No |
0 |
Security profile to apply to the Knowledge Entry |
|
aCustomParameters |
Array |
No |
“” |
Return Values: KnowledgeResponse
See KnowledgeResponse for more information.
KnowledgeRetrieve Transaction
The KnowledgeRetrieve transaction can be used to locate and retrieve an existing knowledge entry.
Input Parameters: KnowledgeRetrieveRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Reference number of the Knowledge Entry to retrieve |
|
aCustomParameters |
Array |
No |
“” |
Return Values: KnowledgeEntityResponse
|
Argument |
Type |
Description |
|---|---|---|
|
Ret |
Error/Warning Number |
|
|
String |
Error/Warning Message |
|
|
ResultSet |
DataSet |
ResultSet containing attribute details |
KnowledgeDelete Transaction
The KnowledgeDelete transaction can be used to delete an existing knowledge entry. This transaction cannot be used to update knowledge entries.
Input Parameters: KnowledgeDeleteRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Reference number of the Knowledge Entry to delete |
|
aCustomParameters |
Array |
No |
“” |
Return Values: KnowledgeResponse
See KnowledgeResponse for more information.
KnowledgeFeedback Transaction
The KnowledgeFeedback transaction can be used to provide feedback on a knowledge entry.
Input Parameters: KnowledgeFeedbackRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Reference number of the Knowledge Entry in which to provide feedback |
|
sComments |
String |
No |
“” |
Feedback comments |
|
lKnowledgeRating |
Lookup Field |
Yes |
- |
Feedback comments |
|
aCustomParameters |
Array |
No |
“” |
Return Values: KnowledgeResponse
See KnowledgeResponse for more information.